DescribeMetricMetaList
Description
Query the description of the time series indicator monitoring item that is open to cloud monitoring.
Request Method
POST
Request Path
/apsara/route/cms/DescribeMetricMetaList
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
MetricName | BODY | string | No | CPUUtilization | monitoring indicator name, press equal to match. |
PageSize | BODY | integer | No | 30 | maximum number per page, default value: 30. |
PageNumber | BODY | integer | No | 1 | paging parameter, default value: 1. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
Labels | BODY | string | No | [{"name":"productCategory","value":"kvstore_old"}] | filter according to tags, format [{"name":"tag name","value":"tag value"},{"name":"tag name","value":"tag value"}] . The existing tag name is described as follows: MetricCategory: description of monitoring item classification alertEnable: whether an alarm is required alertUnit: Recommended alarm unit unitFactor: unit conversion coefficient minAlertPeriod: minimum alarm period productCategory: product type classification |
version | BODY | string | No | 2016-01-01 | version of api |
Namespace | BODY | string | Yes | acs_kvstore | The Namespace to which the indicator belongs, used to distinguish each product configuration. You can call the DescribeProjectMeta to view the Namespace value corresponding to each product. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
Description | string | No sample value for this parameter. | monitoring item description. |
RequestId | string | No sample value for this parameter. | request ID, used to troubleshoot problems. |
Message | string | No sample value for this parameter. | error message. |
Resource | No sample value for this parameter. | specific configuration information. | |
Dimensions | string | No sample value for this parameter. | Dimensions of monitoring items. Multiple are separated by half-width commas (,). |
Labels | string | No sample value for this parameter. | the tag of the monitoring item, is a JSON String[{"name":"tag name","value":"tag value"}], can be multiple, name can be repeated. Description of existing tag name: metricCategory: Indicator classification alertEnable: whether you can alarm alertUnit: alarm unit unitFactor: unit conversion coefficient minAlertPeriod: minimum alarm period productCategory: product |
Unit | string | No sample value for this parameter. | the unit of the monitoring item. |
Code | string | No sample value for this parameter. | status code, 200 indicates success. |
Statistics | string | No sample value for this parameter. | Statistical methods, multiple separated by commas (,), for example: Maximum,Minimum,Average. |
Success | boolean | No sample value for this parameter. | whether it succeeded. |
Namespace | string | No sample value for this parameter. | is used to distinguish product types. the usual naming method is acs_product name. |
MetricName | string | No sample value for this parameter. | monitoring item name. |
Periods | string | No sample value for this parameter. | all statistical periods of monitoring items, multiple separated by commas (,): 15,60,900. |
TotalCount | string | No sample value for this parameter. | total number of records. |
Resources | No sample value for this parameter. | specific configuration information. |
Example
Successful Response example
"The successful response sample is not recognizable. Please modify API definition in API gateway before re-create the API document."
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}